first version #439
first version #439
Conversation
WalkthroughThis pull request adds docopt.net as the 248th RSCG example, bumping the overall project count from 247 to 248 across documentation and data files. Comprehensive example files, metadata, and documentation pages are created for docopt.net, including C# project structure, configuration, and detailed usage documentation. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
v2/rscg_examples/docopt.net/nuget.txt (1)
1-3: Drop the stray closing brace in the quick exampleThere’s an extra
}on the last line, which makes the example snippet look malformed even though it’s only documentation.You can fix it by removing that final brace line:
-docopt.net is the .net version of the docopt python beautiful command line parser. docopt.net helps you define an interface for your command-line app, and automatically generate a parser for it. docopt.net is based on conventions that have been used for decades in help messages and man pages for program interface description. Interface description in docopt.net is such a help message, but formalized. Check out http://docopt.org for a more detailed explanation. - Quick example: var arguments = new DocOpt().Apply("Usage: prog [-a] [-b] FILE", args); if (arguments["-a"].IsTrue) { ... } - } +docopt.net is the .net version of the docopt python beautiful command line parser. docopt.net helps you define an interface for your command-line app, and automatically generate a parser for it. docopt.net is based on conventions that have been used for decades in help messages and man pages for program interface description. Interface description in docopt.net is such a help message, but formalized. Check out http://docopt.org for a more detailed explanation. + Quick example: var arguments = new DocOpt().Apply("Usage: prog [-a] [-b] FILE", args); if (arguments["-a"].IsTrue) { ... }README.md (1)
29-52: Tidy the docopt.net snippet and reconcile the DO‑NOT‑TEST list entryTwo small consistency nits around the new docopt.net example:
Quick example extra brace (lines 41–42)
The docopt.net “Quick example” line already contains both{and}; the following line with an additional}makes the snippet look syntactically wrong, same as innuget.txt. Consider dropping the redundant brace line:
- docopt.net is the .net version of the docopt python beautiful command line parser. docopt.net helps you define an interface for your command-line app, and automatically generate a parser for it. docopt.net is based on conventions that have been used for decades in help messages and man pages for program interface description. Interface description in docopt.net is such a help message, but formalized. Check out http://docopt.org for a more detailed explanation.
Quick example: var arguments = new DocOpt().Apply("Usage: prog [-a] [-b] FILE", args); if (arguments["-a"].IsTrue) { ... }}
- docopt.net is the .net version of the docopt python beautiful command line parser. docopt.net helps you define an interface for your command-line app, and automatically generate a parser for it. docopt.net is based on conventions that have been used for decades in help messages and man pages for program interface description. Interface description in docopt.net is such a help message, but formalized. Check out http://docopt.org for a more detailed explanation.
Quick example: var arguments = new DocOpt().Apply("Usage: prog [-a] [-b] FILE", args); if (arguments["-a"].IsTrue) { ... }
- docopt.net still listed under “Do not want to test 112 (old ISourceGenerator)” (around lines 6240–6243)
Now that docopt.net is an official, tested example (no. 248), that entry in the “Do not want to test” section is stale. I’d either remove docopt.net from that list or add a short note indicating it’s now covered in the main examples list.Also applies to: 6240-6243
v2/rscg_examples/docopt.net/description.json (1)
15-16: Minor: Consider removing empty string entries in arrays.The
excludeDirectoryGeneratedandincludeAdditionalFilesarrays contain empty string entries. If these fields are unused, consider using empty arrays[]instead for cleaner JSON structure.Apply this diff if you want to clean up the empty arrays:
- "excludeDirectoryGenerated":[""], - "includeAdditionalFiles":[""] + "excludeDirectoryGenerated":[], + "includeAdditionalFiles":[]v2/rscg_examples_site/docs/RSCG-Examples/docopt.net.md (2)
189-192: Minor: Replace hard tabs with spaces in code blocks.Lines 189-192 contain hard tabs in the XML code block. For consistency with markdown best practices, consider using spaces instead.
29-29: Optional: Consider formatting bare URLs.Several bare URLs throughout the document (lines 29, 36, 39, 41, 118, etc.) could be formatted in angle brackets
<url>for better markdown compliance and rendering consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
v2/Generator/all.csvis excluded by!**/*.csvv2/rscg_examples_site/static/exports/RSCG.xlsxis excluded by!**/*.xlsxv2/rscg_examples_site/static/sources/docopt.net.zipis excluded by!**/*.zip
📒 Files selected for processing (24)
README.md(2 hunks)later.md(1 hunks)v2/.tours/docopt.net.tour(1 hunks)v2/RSCGExamplesData/GeneratorDataRec.json(1 hunks)v2/book/examples/docopt.net.html(1 hunks)v2/book/list.html(2 hunks)v2/book/pandocHTML.yaml(1 hunks)v2/rscg_examples/docopt.net/description.json(1 hunks)v2/rscg_examples/docopt.net/nuget.txt(1 hunks)v2/rscg_examples/docopt.net/readme.txt(1 hunks)v2/rscg_examples/docopt.net/src/ConsoleArgs.slnx(1 hunks)v2/rscg_examples/docopt.net/src/ConsoleArgs/ConsoleArgs.csproj(1 hunks)v2/rscg_examples/docopt.net/src/ConsoleArgs/Program.cs(1 hunks)v2/rscg_examples/docopt.net/src/ConsoleArgs/Program.docopt.txt(1 hunks)v2/rscg_examples/docopt.net/video.json(1 hunks)v2/rscg_examples_site/docs/Authors/Atif_Aziz.md(1 hunks)v2/rscg_examples_site/docs/Categories/CommandLine.md(1 hunks)v2/rscg_examples_site/docs/Categories/_PrimitiveCommandLine.mdx(1 hunks)v2/rscg_examples_site/docs/RSCG-Examples/docopt.net.md(1 hunks)v2/rscg_examples_site/docs/RSCG-Examples/index.md(4 hunks)v2/rscg_examples_site/docs/about.md(1 hunks)v2/rscg_examples_site/docs/indexRSCG.md(2 hunks)v2/rscg_examples_site/src/components/HomepageFeatures/index.js(1 hunks)v2/rscg_examples_site/static/exports/RSCG.json(1 hunks)
🧰 Additional context used
🪛 Biome (2.1.2)
v2/rscg_examples/docopt.net/video.json
[error] 35-36: Property key must be double quoted
(parse)
[error] 36-36: unexpected character =
(parse)
[error] 36-36: expected , but instead found " "
Remove " "
(parse)
[error] 36-36: expected : but instead found }
Remove }
(parse)
[error] 37-38: Expected an array, an object, or a literal but instead found ']'.
Expected an array, an object, or a literal here.
(parse)
🪛 LanguageTool
v2/rscg_examples_site/docs/RSCG-Examples/docopt.net.md
[grammar] ~29-~29: Use a hyphen to join words.
Context: ...n of the docopt python beautiful command line parser. docopt.net helps you defin...
(QB_NEW_EN_HYPHEN)
[style] ~29-~29: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...automatically generate a parser for it. docopt.net is based on conventions that have b...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
v2/rscg_examples/docopt.net/nuget.txt
[grammar] ~1-~1: Use a hyphen to join words.
Context: ...n of the docopt python beautiful command line parser. docopt.net helps you defin...
(QB_NEW_EN_HYPHEN)
[style] ~1-~1: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...automatically generate a parser for it. docopt.net is based on conventions that have b...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
v2/rscg_examples_site/docs/Categories/_PrimitiveCommandLine.mdx
[style] ~11-~11: Using many exclamation marks might seem excessive (in this case: 10 exclamation marks for a text that’s 1433 characters long)
Context: ...) 2025-12-15 5 TeCLI 
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
v2/rscg_examples_site/docs/indexRSCG.md
23-23: Spaces inside link text
(MD039, no-space-in-links)
v2/rscg_examples_site/docs/RSCG-Examples/docopt.net.md
29-29: Bare URL used
(MD034, no-bare-urls)
36-36: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
84-84: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
118-118: Bare URL used
(MD034, no-bare-urls)
128-128: Bare URL used
(MD034, no-bare-urls)
129-129: Bare URL used
(MD034, no-bare-urls)
176-176: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
189-189: Hard tabs
Column: 1
(MD010, no-hard-tabs)
190-190: Hard tabs
Column: 1
(MD010, no-hard-tabs)
191-191: Hard tabs
Column: 1
(MD010, no-hard-tabs)
192-192: Hard tabs
Column: 1
(MD010, no-hard-tabs)
203-203: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
213-213: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
474-474: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
474-474: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
README.md
40-40: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: call-workflow-passing-data / build (24.3.0)
🔇 Additional comments (21)
v2/rscg_examples_site/docs/about.md (1)
8-10: Count bumped to 248 consistently with the rest of the siteThe updated number matches the new total examples and other files in this PR.
v2/rscg_examples_site/src/components/HomepageFeatures/index.js (1)
5-8: Homepage hero count correctly updated to 248Title now reflects the new total examples and stays in sync with docs/README.
later.md (1)
3-4: Latest update date aligned with READMEThe new date matches the global “Latest Update” in README; no issues.
v2/rscg_examples_site/docs/Categories/_PrimitiveCommandLine.mdx (1)
3-11: docopt.net entry and reordering in CommandLine category look consistentThe new docopt.net row (link, NuGet badge, stars, date) follows the existing pattern, and TeCLI’s move to 5 keeps numbering coherent.
v2/rscg_examples_site/docs/Authors/Atif_Aziz.md (1)
1-7: Author page for Atif Aziz wired correctly to docopt.netAuthor name, RSCG count, and the docopt.net entry (with badges and date) are coherent with the rest of the site.
README.md (1)
1-7: Global counters and “Latest Update” correctly bumped to 248 / 2025‑12‑15The main heading, introductory sentence, and “Latest Update” date are all in sync with the new docopt.net example and the other updated docs.
Also applies to: 25-28
v2/rscg_examples/docopt.net/src/ConsoleArgs/Program.cs (1)
1-2: ConsoleArgs sample correctly surfaces docopt usageSimple top‑level program that prints
ProgramArguments.Usage(with an optional commented‑outHelpline) is appropriate for this example; no issues.v2/rscg_examples_site/docs/Categories/CommandLine.md (1)
3-3: Category list update is correct and well-ordered.The CommandLine category now includes docopt.net as the newest entry (item 4), with TeCLI correctly repositioned to item 5. The count has been incremented from 4 to 5, and the chronological ordering is maintained.
Also applies to: 11-13
v2/book/pandocHTML.yaml (1)
264-264: Input file entry is correctly formatted and positioned.The docopt.net example has been properly added to the pandoc input-files list in the correct location and format.
v2/rscg_examples/docopt.net/src/ConsoleArgs.slnx (1)
1-3: Solution descriptor is minimal and correct.The ConsoleArgs solution properly references the ConsoleArgs.csproj project file with appropriate path resolution.
v2/book/list.html (1)
20-20: List has been correctly incremented to 248 entries with proper row structure.The docopt.net entry (row 248) is correctly added with accurate numbering, link formatting, and chronological ordering relative to adjacent entries.
Also applies to: 1017-1020
v2/rscg_examples/docopt.net/src/ConsoleArgs/ConsoleArgs.csproj (2)
13-16: Compiler-generated files configuration is appropriately set.EmitCompilerGeneratedFiles is enabled and directed to a GX subdirectory under the intermediate output path, which is the standard pattern for RSCG examples in this repository.
5-5: No action needed. The project correctly targets net10.0 (released November 11, 2025) and uses docopt.net 0.8.1 (available on NuGet). Both versions are currently available and valid.v2/rscg_examples_site/docs/indexRSCG.md (1)
10-10: Count increment is correct and consistently applied.Both the heading (line 10) and introductory sentence (line 12) have been updated from 247 to 248, reflecting the addition of docopt.net as the newest RSCG example.
Also applies to: 12-12
v2/RSCGExamplesData/GeneratorDataRec.json (1)
1501-1506: Generator data entry is properly structured and consistent.The docopt.net entry in GeneratorDataRec.json follows the established schema with correct ID, Category (32 for CommandLine), date, and visibility flag. The JSON structure is valid and consistent with surrounding entries.
v2/rscg_examples/docopt.net/readme.txt (1)
1-101: Documentation is comprehensive and properly formatted.The readme provides a clear overview of docopt.net, includes a practical usage example, installation instructions, and proper copyright/license attribution. The documentation aligns with the pattern used for other RSCG examples.
v2/rscg_examples/docopt.net/src/ConsoleArgs/Program.docopt.txt (1)
1-12: LGTM! Docopt specification is well-formed.The usage specification follows docopt conventions correctly with clear command definitions, arguments, and options.
v2/book/examples/docopt.net.html (1)
1-59: LGTM! HTML documentation structure is correct.The documentation page follows the standard format for RSCG examples with appropriate sections for info, author, usage instructions, and download links.
v2/.tours/docopt.net.tour (1)
1-36: LGTM! CodeTour configuration is properly structured.The tour steps correctly reference the project files and generated source, with appropriate descriptions for walking through the docopt.net example.
v2/rscg_examples_site/static/exports/RSCG.json (1)
1981-1988: LGTM! Export entry is correctly formatted.The new docopt.net entry follows the established structure with all required fields (Name, Link, NuGet, Source, Category, AddedOn) and is properly positioned as entry 248.
v2/rscg_examples_site/docs/RSCG-Examples/index.md (1)
3-4: LGTM! Index correctly updated for 248 examples.All changes appropriately reflect the addition of docopt.net:
- Title and description updated to reflect 248 total examples
- CommandLine category count incremented from 4 to 5
- New docopt.net link added to CommandLine section
- Mermaid diagram updated with new edge
Also applies to: 278-278, 299-303, 1641-1642
|
|
||
| | No | Name | Date | Category | | ||
| | --------- | ----- | ---- | -------- | | ||
| |248| [docopt.net by Atif Aziz ](/docs/docopt.net)|2025-12-15 => 15 December 2025 | [CommandLine](/docs/Categories/CommandLine) | |
There was a problem hiding this comment.
Fix markdown link formatting to comply with linting rules.
Line 23 has a space inside the link text ([docopt.net by Atif Aziz ]) which violates the MD039 rule (no-space-in-links). Remove the space before the closing bracket to match the pattern used in surrounding entries.
-|248| [docopt.net by Atif Aziz ](/docs/docopt.net)|2025-12-15 => 15 December 2025 | [CommandLine](/docs/Categories/CommandLine) |
+|248| [docopt.net by Atif Aziz](/docs/docopt.net)|2025-12-15 => 15 December 2025 | [CommandLine](/docs/Categories/CommandLine) |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| |248| [docopt.net by Atif Aziz ](/docs/docopt.net)|2025-12-15 => 15 December 2025 | [CommandLine](/docs/Categories/CommandLine) | | |
| |248| [docopt.net by Atif Aziz](/docs/docopt.net)|2025-12-15 => 15 December 2025 | [CommandLine](/docs/Categories/CommandLine) | |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
23-23: Spaces inside link text
(MD039, no-space-in-links)
🤖 Prompt for AI Agents
In v2/rscg_examples_site/docs/indexRSCG.md around line 23, the markdown link
text contains an extra space before the closing bracket ("[docopt.net by Atif
Aziz ]"), violating MD039; remove the trailing space so the link text reads
"[docopt.net by Atif Aziz]" (keeping the rest of the row unchanged) to comply
with linting.
| {"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-", | ||
| SpeakTest=" "}, | ||
| {"typeStep":"waitseconds","arg":"30"}, |
There was a problem hiding this comment.
Critical: Fix JSON syntax error.
Lines 35-37 contain a malformed JSON structure. The SpeakTest property appears outside of the object definition, causing parse errors.
Apply this diff to fix the syntax error:
-{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-",
-SpeakTest=" "},
+{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-"},If SpeakTest is needed, it should be inside the object:
-{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-",
-SpeakTest=" "},
+{"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-", "SpeakTest":" "},📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-", | |
| SpeakTest=" "}, | |
| {"typeStep":"waitseconds","arg":"30"}, | |
| {"typeStep":"browser","arg":"https://ignatandrei.github.io/RSCG_Examples/v2/docs/docopt.net#download-example-net--c-", "SpeakTest":" "}, | |
| {"typeStep":"waitseconds","arg":"30"}, |
🧰 Tools
🪛 Biome (2.1.2)
[error] 35-36: Property key must be double quoted
(parse)
[error] 36-36: unexpected character =
(parse)
[error] 36-36: expected , but instead found " "
Remove " "
(parse)
[error] 36-36: expected : but instead found }
Remove }
(parse)
🤖 Prompt for AI Agents
In v2/rscg_examples/docopt.net/video.json around lines 35 to 37, the JSON is
malformed because the SpeakTest property appears outside the object literal; fix
by placing "SpeakTest" as a key inside the preceding object (or remove it if
unused), ensuring the object uses proper JSON syntax (quotes around property
name, colon and value) and that items are comma-separated correctly so the array
remains valid.
Summary by CodeRabbit
New Features
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.